/* Copyright (c) 2007  Peter Palotas
 *  
 *  This software is provided 'as-is', without any express or implied
 *  warranty. In no event will the authors be held liable for any damages
 *  arising from the use of this software.
 *  
 *  Permission is granted to anyone to use this software for any purpose,
 *  including commercial applications, and to alter it and redistribute it
 *  freely, subject to the following restrictions:
 *  
 *      1. The origin of this software must not be misrepresented; you must not
 *      claim that you wrote the original software. If you use this software
 *      in a product, an acknowledgment in the product documentation would be
 *      appreciated but is not required.
 *  
 *      2. Altered source versions must be plainly marked as such, and must not be
 *      misrepresented as being the original software.
 *  
 *      3. This notice may not be removed or altered from any source
 *      distribution.
 *  
 *  
 *  $Id: IOption.cs 19 2007-08-15 13:14:32Z palotas $
 */
using System;
using SCG = System.Collections.Generic;
using System.Text;
using C5;

namespace Plossum.CommandLine
{
    internal interface IOption
    {
        #region Public Properties

        object Value
        {
            set;
        }

        bool RequiresValue
        {
            get;
        }

        bool RequireExplicitAssignment
        {
            get;
            set;
        }

        ICollection<Option> ProhibitedBy
        {
            get;
        }

        OptionGroup Group
        {
            get;
        }

        string Name
        {
            get;
        }

        BoolFunction BoolFunction
        {
            get;
        }

        int MaxOccurs
        {
            get;
        }

        int MinOccurs
        {
            get;
        }

        string Description
        {
            get;
        }

        int SetCount
        {
            get;
            set;
        }

        bool AcceptsValue
        {
            get;
        }

        bool HasDefaultValue
        {
            get;
        }

        bool IsBooleanType
        {
            get;
        }

        bool IsAlias
        {
            get;
        }

        Option DefiningOption
        {
            get;
        }

        bool IsIntegralType
        {
            get;
        }

        bool IsFloatingPointType
        {
            get;
        }

        bool IsDecimalType
        {
            get;
        }

        bool IsNumericalType
        {
            get;
        }

        object MinValue
        {
            get;
        }

        object MaxValue
        {
            get;
        }

        #endregion

        #region Public methods

        void SetDefaultValue();

        #endregion
    }
}
